Authorize Recurring Pix

Esta página irá guiá-lo através das solicitações de autorização.

Respondendo solicitação de autorização (jornada 1)

Usado pela jornada 1.

Requisição

PUT 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:recurrenceId'

Cabeçalhos

Nome	Descrição
Authorization	Obrigatório. Chave da API
idempotencyKey	Obrigatório. Guid

Parâmetros de Path

Nome	Tipo	Descrição
recurrenceId	string	Obrigatório. RecurrenceId da autorização

Corpo

Nome	Tipo	Descrição
AuthorizationResult	boolean	Obrigatório. Indica se a autorização foi aprovada (true) ou rejeitada (false)
PayerMaxAmount	number	Opcional. Valor máximo autorizado pelo pagador
RejectionReason	string	Opcional. Motivo da rejeição (obrigatório se AuthorizationResult for false)

{
  "AuthorizationResult": true
}

Resposta

O status code 200 indica sucesso na consulta.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
 "recurrenceId": "RR3822485720251212i0jYqQr7g5n",
 "requestedAt": "2026-01-16T17:52:54.112"
}

Respondendo solicitação de autorização (jornadas 2 e 4)

Usado pelas jornadas 2 e 4.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/automatic/authorizations/:recurrenceId'

Cabeçalhos

Nome	Descrição
Authorization	Obrigatório. Chave da API
idempotencyKey	Obrigatório. Guid

Parâmetros de Path

Nome	Tipo	Descrição
recurrenceId	string	Obrigatório. RecurrenceId da autorização

Corpo

Nome	Tipo	Descrição
journey	number	Obrigatório. Identificador da jornada (ex.: 2 ou 4)
frequencyType	enum	Obrigatório. Tipo de frequência. Domínios: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY
recurrenceStartDate	string	Opcional. Data de início da recorrência
recurrenceEndDate	string	Opcional. Data de fim da recorrência
amount	number	Opcional. Valor da transação
minPayerMaxAmount	number	Opcional. Valor mínimo permitido para o valor máximo do pagador
payerMaxAmount	number	Opcional. Valor máximo autorizado pelo pagador
beneficiary	object	Opcional. Objeto contendo informações do beneficiário
beneficiary.ispb	string	Obrigatório. Código ISPB do beneficiário
beneficiary.document	string	Obrigatório. Documento do beneficiário (CPF/CNPJ)
beneficiary.name	string	Obrigatório. Nome completo do beneficiário
beneficiary.agencyNumber	string	Opcional. Agência do beneficiário
beneficiary.accountType	enum	Opcional. Tipo de conta do beneficiário. Domínios: CURRENT, WAGE, SAVINGS, PAYMENT
beneficiary.accountNumber	string	Opcional. Número da conta do beneficiário
payer	object	Opcional. Objeto contendo informações do pagador
payer.ispb	string	Obrigatório. Código ISPB do pagador
payer.type	enum	Obrigatório. Tipo do documento do pagador. Domínios: NATURAL - Pessoa Física LEGAL - Pessoa Jurídica
payer.document	string	Obrigatório. Documento do pagador (CPF/CNPJ)
payer.name	string	Opcional. Nome completo do pagador
payer.agencyNumber	string	Opcional. Agência do pagador
payer.accountType	enum	Opcional. Tipo de conta do pagador. Domínios: CURRENT, WAGE, SAVINGS, PAYMENT
payer.accountNumber	string	Opcional. Número da conta do pagador
payer.municipalityIbgeCode	number	Opcional. Código IBGE do município do pagador
debtor	object	Opcional. Objeto contendo informações do devedor
debtor.type	enum	Obrigatório. Tipo do documento do devedor. Domínios: NATURAL - Pessoa Física LEGAL - Pessoa Jurídica
debtor.document	string	Obrigatório. Documento do devedor (CPF/CNPJ)
debtor.name	string	Obrigatório. Nome completo do devedor
contractNumber	string	Obrigatório. Número do contrato
contractDescription	string	Opcional. Descrição do contrato
settlementConfirmedAt	string	Opcional. Data/hora de confirmação da liquidação

{
  "journey": 2,
  "frequencyType": "MONTHLY",
  "recurrenceStartDate": "2025-06-29",
  "recurrenceEndDate": "2026-06-29",
  "amount": 150.75,
  "minPayerMaxAmount": 150.75,
  "payerMaxAmount": 500.00,
  "beneficiary": {
    "ispb": "38224857",
    "document": "12345678901",
    "name": "Fulano Ciclano",
    "agencyNumber": "0001",
    "accountType": "CURRENT",
    "accountNumber": "31747"
  },
  "payer": {
    "ispb": "38224857",
    "type": "NATURAL",
    "document": "07161543584",
    "name": "Beltrano",
    "agencyNumber": "0001",
    "accountType": "CURRENT",
    "accountNumber": "12345",
    "municipalityIbgeCode": 3550308
  },
  "debtor": {
    "type": "NATURAL",
    "document": "07161543584",
    "name": "Beltrano"
  },
  "contractNumber": "CONTRATO123",
  "contractDescription": "Assinatura Premium",
  "settlementConfirmedAt": "2025-06-15T12:05:00.000Z"
}

Resposta

O status code 200 indica sucesso na consulta.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
 "recurrenceId": "RR3822485720251212i0jYqQr7g5n",
 "requestedAt": "2026-01-16T17:52:54.112"
}